API Keys
In the AutomatR Orchestrator application, the API Keys tab is a section dedicated to managing API keys, which are essential for secure authentication and authorization when interacting with the AutomatR Orchestrator's API. The API Keys tab displays a table containing the following columns:
| Field | Description |
|---|---|
| Key | This column lists the generated API keys. Each API key is a unique alphanumeric code used for authentication purposes. |
| Generated Date | The Generated Date column indicates when each API key was created or generated. |
Add API Key
Here's a brief procedure for adding an API key in the AutomatR Orchestrator application:
Log in to the AutomatR Orchestrator application using your credentials.
Once logged in, navigate to the API Keys tab within the application. This tab is where you manage and generate API keys for secure API access.
On the API Keys tab, locate the + (Add) button, typically positioned above the API keys table to generate an API Key.
Click on the + (Add) button to initiate the process of generating a new API key. Upon clicking, the system will automatically create a unique API key for you.
After the key is generated, it will be automatically added to the API keys table in the Key column. The Generated Date column will display the date when the API key was created.
Review the generated API key and its associated information in the table to ensure accuracy.
Copy API Key
- By navigating the mouse pointer over the API key displayed in the table, users will observe a Copy option. This option allows users to swiftly duplicate the API key to their clipboard, facilitating efficient and accurate usage for API access.
Delete API Key
- If you wish to remove an API key from the list, locate the respective entry in the table. In the Actions column, click on the Delete option corresponding to the API key you want to remove. Confirm the deletion if prompted.
Note: Ensure that you treat the generated API key with utmost confidentiality, as it grants access to the AutomatR Orchestrator's API. Keep the API key secure and avoid sharing it in public or untrusted environments.
Adding an API key in the AutomatR Orchestrator application involves clicking the + (Add) button on the API Keys tab. The system automatically generates a new API key and adds it to the API keys table, along with the date of generation. This newly generated API key can be copied and used to securely access the AutomatR Orchestrator's API for authorized interactions.